Skip to content

Launch-grade README and repository hygiene - #8

Merged
sahiljagtap08 merged 3 commits into
mainfrom
launch/readme-polish
Nov 13, 2026
Merged

sahiljagtap08 merged 3 commits into
mainfrom
launch/readme-polish

Conversation

@sahiljagtap08

Copy link
Copy Markdown
Contributor

What changed

  • README.md rewritten to the launch layout: centered logo (light variant for dark mode) and badges (PyPI, Python versions, licence, CI, release, docs), links row, what it is, install, a quickstart that connects, creates, screenshots, clicks, runs a shell action, verifies and destroys, a Mermaid diagram, then sections for computers, actions, verify and the trusted flag, runs, MCP (hosted and local, the confirm: true rule, the HTTPS-only transport rule), the async client, an errors table, a configuration table, development, versioning, security, contributing, licence and status.
  • SECURITY.md (supported versions, private reporting first through GitHub then security@drums.run, response times, what the SDK guarantees, the runtime's known limitations stated plainly), CODE_OF_CONDUCT.md (Contributor Covenant 2.1), CONTRIBUTING.md with DCO sign-off, issue templates (bug, feature, contact links), a pull request template and dependabot.yml (pip and GitHub Actions).
  • ci.yml runs the suite on 3.9, 3.10, 3.11, 3.12 and 3.13 (was 3.9, 3.12, 3.13), so the README's claim is literal. RELEASE.md drops the first-release wording.
  • docs/assets/drums-symbol.svg and drums-symbol-light.svg; the README references them by their raw URL on main, so the logo shows once this merges.

No code or packaging change; no version bump; the v0.3.0 tag is untouched.

How it was tested

  • Every Python block in the README extracted and py_compiled on Python 3.9.
  • The quickstart and the async example run verbatim from the built 0.3.0 wheel in a fresh 3.9 venv against the fake gateway from tests/ (no production key was available for this run): score 1 valid True [], 8 concurrent creates and verifies in the async example. The SDK was also pointed at https://beta.drums.run/gw with a placeholder key and raised AuthError 401 unauthenticated, so the URL and transport rule in the README are right.
  • From the same venv: drums version, drums --help, drums mcp --help, drums mcp --print-config claude|claude-local|cursor|codex (outputs pasted into the README), drums mcp --url http://... refused with exit 2, and a stdio initialize + tools/list round trip (34 tools, three destructive).
  • python -m unittest discover -s tests on 3.9, 3.10, 3.11, 3.12 and 3.13 (76 tests each, OK); python -m build and twine check --strict pass with the new README as the long description.
  • Every link in README, SECURITY, CONTRIBUTING and CODE_OF_CONDUCT checked (200), except the two logo URLs on main, which resolve after merge (verified on this branch).
  • Tree swept for account ids, hostnames, addresses, emails and keys: only synthetic test fixtures remain.

…ns, verify, runs, MCP, async, errors, configuration, status

Signed-off-by: Sahil Jagtap <sahil.jagtap45@gmail.com>
…ue and PR templates, dependabot

Signed-off-by: Sahil Jagtap <sahil.jagtap45@gmail.com>
…t-release wording

Signed-off-by: Sahil Jagtap <sahil.jagtap45@gmail.com>
@sahiljagtap08
sahiljagtap08 merged commit b20d9aa into main Nov 13, 2026
5 checks passed
@sahiljagtap08
sahiljagtap08 deleted the launch/readme-polish branch November 13, 2026 07:10
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant